//----------------------------------------------------------------------------
// File: OS_ErrorCodes.h
// Type: Error Code Definitions.
// Author: Ken Anderson
// Date: 3/2/3 -- 7:25PM
// OS dependant: NA
//
// Notes: Contains a set of error codes that are used by the OS_API_TEMPLATE
//        class.  The error codes listed below are not OS dependant.
//
// Header file's required:
// 1) Common.h --  Contains core C headers as well as common definitions.
//
//----------------------------------------------------------------------------

#include "Common.h"

//////////////////////////// 
// ERROR CODE DEFINITIONS //
////////////////////////////

typedef ECTYPE OS_ERR;

//OSE = Operating System Error
#define OSE_MEDIA_NOT_FOUND			(0x01 + ECERR_BASECOUNT)	//The media file was not found.
#define OSE_INVALID_HANDLE			(0x02 + ECERR_BASECOUNT)	//The pointer to pointer(handle) is not valid or null
#define OSE_NOT_ENOUGH_MEM			(0x03 + ECERR_BASECOUNT)	//Can complete command as we are out of memory.
#define OSE_INVALID_NAME			(0x04 + ECERR_BASECOUNT)	//Invalid file, directory or volume label.
#define OSE_SHUTDOWN				(0x05 + ECERR_BASECOUNT)	//Shutdown of the OS is in progress.
#define OSE_INVALID_DYNAMIC_LIBRARY (0x06 + ECERR_BASECOUNT)	//The dynamic library(DLL in Win32) is invalid.
#define OSE_FILE_CORRUPT			(0x07 + ECERR_BASECOUNT)	//The file being accessed is corrupted.
#define OSE_NULL_IMAGE				(0x08 + ECERR_BASECOUNT)	//The system image being rendered is null.
#define OSE_MEDIA_NA				(0x09 + ECERR_BASECOUNT)	//The media being sent to the DrawScreen is not supported.
#define OSE_FILE_EXISTS				(0x0A + ECERR_BASECOUNT)	//File already exists & can not be created.
#define OSE_FILE_EOF				(0x0B + ECERR_BASECOUNT)	//End of the file was reached.
#define OSE_FILE_NOTFOUND			(0x0C + ECERR_BASECOUNT)

//Error codes that may only be supported by one or a few OSes.
//Win32 Supported.
#define OSE_INVALID_WIN_HANDLE      (0x0D + ECERR_BASECOUNT)	//The handle for the window is invalid.
#define OSE_INVALID_MENU_HANDLE		(0x0E + ECERR_BASECOUNT)	//The handle for the menu is invalid.
#define OSE_INVALID_CUR_HANDLE		(0x0F + ECERR_BASECOUNT)	//The handle for the cursor is invalid.

// --- kda (3/18/12) --- Invalid module message is needed.
#define OSE_INVALID_MODULE_HANDLE   (0x10 + ECERR_BASECOUNT)